<?php  //$Id: grade_form.php,v 1.10.2.3 2008/03/03 10:21:41 nicolasconnault Exp $

///////////////////////////////////////////////////////////////////////////
//																	   //
// NOTICE OF COPYRIGHT												   //
//																	   //
// Moodle - Modular Object-Oriented Dynamic Learning Environment		 //
//		  http://moodle.com											//
//																	   //
// Copyright (C) 1999 onwards  Martin Dougiamas  http://moodle.com	   //
//																	   //
// This program is free software; you can redistribute it and/or modify  //
// it under the terms of the GNU General Public License as published by  //
// the Free Software Foundation; either version 2 of the License, or	 //
// (at your option) any later version.								   //
//																	   //
// This program is distributed in the hope that it will be useful,	   //
// but WITHOUT ANY WARRANTY; without even the implied warranty of		//
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the		 //
// GNU General Public License for more details:						  //
//																	   //
//		  http://www.gnu.org/copyleft/gpl.html						 //
//																	   //
///////////////////////////////////////////////////////////////////////////

require_once $CFG->libdir.'/formslib.php';

class edit_grade_form extends moodleform {

	function definition() {
		global $CFG, $COURSE;

		$mform =& $this->_form;

		$grade_item = $this->_customdata['grade_item'];
		$gpr		= $this->_customdata['gpr'];

		/// information fields
		$mform->addElement('static', 'user', get_string('user'));
		$mform->addElement('static', 'itemname', get_string('itemname', 'grades'));

		$mform->addElement('checkbox', 'overridden', get_string('overridden', 'grades'));
		$mform->setHelpButton('overridden', array('overridden', get_string('overridden', 'grades'), 'grade'));

		/// actual grade - numeric or scale
		if ($grade_item->gradetype == GRADE_TYPE_VALUE) {
			// numeric grade
			$mform->addElement('text', 'finalgrade', get_string('finalgrade', 'grades'));
			$mform->setHelpButton('finalgrade', array('finalgrade', get_string('finalgrade', 'grades'), 'grade'));
			$mform->disabledIf('finalgrade', 'overridden', 'notchecked');

		} else if ($grade_item->gradetype == GRADE_TYPE_SCALE) {
			// scale grade
			$scaleopt = array();

			if (empty($grade_item->outcomeid)) {
				$scaleopt[-1] = get_string('nograde');
			} else {
				$scaleopt[-1] = get_string('nooutcome', 'grades');
			}

			$i = 1;
			if ($scale = get_record('scale', 'id', $grade_item->scaleid)) {
				foreach (split(",", $scale->scale) as $option) {
					$scaleopt[$i] = $option;
					$i++;
				}
			}

			$mform->addElement('select', 'finalgrade', get_string('finalgrade', 'grades'), $scaleopt);
			$mform->setHelpButton('finalgrade', array('finalgrade', get_string('finalgrade', 'grades'), 'grade'));
			$mform->disabledIf('finalgrade', 'overridden', 'notchecked');
		}

		$mform->addElement('advcheckbox', 'excluded', get_string('excluded', 'grades'));
		$mform->setHelpButton('excluded', array('excluded', get_string('excluded', 'grades'), 'grade'));

		/// hiding
		/// advcheckbox is not compatible with disabledIf !!
		$mform->addElement('checkbox', 'hidden', get_string('hidden', 'grades'));
		$mform->setHelpButton('hidden', array('hidden', get_string('hidden', 'grades'), 'grade'));
		$mform->addElement('date_time_selector', 'hiddenuntil', get_string('hiddenuntil', 'grades'), array('optional'=>true));
		$mform->setHelpButton('hiddenuntil', array('hiddenuntil', get_string('hiddenuntil', 'grades'), 'grade'));
		$mform->disabledIf('hidden', 'hiddenuntil[off]', 'notchecked');

		/// locking
		$mform->addElement('advcheckbox', 'locked', get_string('locked', 'grades'));
		$mform->setHelpButton('locked', array('locked', get_string('locked', 'grades'), 'grade'));
		$mform->addElement('date_time_selector', 'locktime', get_string('locktime', 'grades'), array('optional'=>true));
		$mform->setHelpButton('locktime', array('lockedafter', get_string('locktime', 'grades'), 'grade'));
		$mform->disabledIf('locktime', 'gradetype', 'eq', GRADE_TYPE_NONE);

		// Feedback format is automatically converted to html if user has enabled editor
		$mform->addElement('htmleditor', 'feedback', get_string('feedback', 'grades'),
			array('rows'=>'15', 'course'=>$COURSE->id, 'cols'=>'45'));
		$mform->setHelpButton('feedback', array('feedback', get_string('feedback', 'grades'), 'grade'));
		$mform->setType('text', PARAM_RAW); // to be cleaned before display, no XSS risk
		$mform->addElement('format', 'feedbackformat', get_string('format'));
		$mform->setHelpButton('feedbackformat', array('textformat', get_string('helpformatting')));
		//TODO: unfortunately we can not disable html editor for external grades when overridden off :-(

		// hidden params
		$mform->addElement('hidden', 'oldgrade');
		$mform->addElement('hidden', 'oldfeedback');

		$mform->addElement('hidden', 'id', 0);
		$mform->setType('id', PARAM_INT);

		$mform->addElement('hidden', 'itemid', 0);
		$mform->setType('itemid', PARAM_INT);

		$mform->addElement('hidden', 'userid', 0);
		$mform->setType('userid', PARAM_INT);

		$mform->addElement('hidden', 'courseid', $COURSE->id);
		$mform->setType('courseid', PARAM_INT);

/// add return tracking info
		$gpr->add_mform_elements($mform);

//-------------------------------------------------------------------------------
		// buttons
		$this->add_action_buttons();
	}

	function definition_after_data() {
		global $CFG, $COURSE;

		$context = get_context_instance(CONTEXT_COURSE, $COURSE->id);

		$mform =& $this->_form;
		$grade_item = $this->_customdata['grade_item'];

		// fill in user name if user still exists
		$userid = $mform->getElementValue('userid');
		if ($user = get_record('user', 'id', $userid)) {
			$username = '<a href="'.$CFG->wwwroot.'/user/view.php?id='.$userid.'">'.fullname($user).'</a>';
			$user_el =& $mform->getElement('user');
			$user_el->setValue($username);
		}

		// add activity name + link
		if ($grade_item->itemtype == 'mod') {
			$cm = get_coursemodule_from_instance($grade_item->itemmodule, $grade_item->iteminstance, $grade_item->courseid);
			$itemname = '<a href="'.$CFG->wwwroot.'/mod/'.$grade_item->itemmodule.'/view.php?id='.$cm->id.'">'.$grade_item->get_name().'</a>';
		} else {
			$itemname = $grade_item->get_name();
		}
		$itemname_el =& $mform->getElement('itemname');
		$itemname_el->setValue($itemname);

		// access control - disable not allowed elements
		if (!has_capability('moodle/grade:manage', $context)) {
			$mform->hardFreeze('excluded');
		}

		if (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:hide', $context)) {
			$mform->hardFreeze('hidden');
			$mform->hardFreeze('hiddenuntil');
		}

		$old_grade_grade = new grade_grade(array('itemid'=>$grade_item->id, 'userid'=>$userid));

		if (!$grade_item->is_overridable_item()) {
			$mform->removeElement('overridden');
		}

		if ($grade_item->is_hidden()) {
			$mform->hardFreeze('hidden');
		}

		if ($old_grade_grade->is_locked()) {
			if ($grade_item->is_locked()) {
				$mform->hardFreeze('locked');
				$mform->hardFreeze('locktime');
			}

			$mform->hardFreeze('overridden');
			$mform->hardFreeze('finalgrade');
			$mform->hardFreeze('feedback');

		} else {
			if (empty($old_grade_grade->id)) {
				$old_grade_grade->locked = $grade_item->locked;
				$old_grade_grade->locktime = $grade_item->locktime;
			}

			if (($old_grade_grade->locked or $old_grade_grade->locktime)
			  and (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:unlock', $context))) {
				$mform->hardFreeze('locked');
				$mform->hardFreeze('locktime');

			} else if ((!$old_grade_grade->locked and !$old_grade_grade->locktime)
			  and (!has_capability('moodle/grade:manage', $context) and !has_capability('moodle/grade:lock', $context))) {
				$mform->hardFreeze('locked');
				$mform->hardFreeze('locktime');
			}
		}
	}
}

?>
